ποΈGitΠ―ΡΠ°ποΈ
README.md chore/remove-misplaced-docs-sync-workflow (1353ba25) Text, 10.80 KB
<p align="center">
<img src=".github/meshtastic_logo.png" alt="Meshtastic Logo" width="200"/>
</p>
<h1 align="center">Meshtastic-Android</h1>
This is a tool for using Android (and Compose Desktop) with open-source mesh radios. For more information see our webpage: meshtastic.org. If you are looking for the device side code, see here.
If you have questions or feedback please Join our discussion forum or the Discord Group. We would love to hear from you!
Features
Highlights from the latest release:
β’ Full-text message search across your conversation history.
β’ Mesh network discovery to surface nodes and channels around you.
β’ Android Auto support for hands-free use while driving (T383838google flavor).
β’ Air-quality telemetry β PM1.0, PM2.5, PM10, and COβ readings from supported sensors.
β’ Device hardware links via msh.to for quick access to hardware details.
β’ App Functions / system-AI integration so on-device assistants can trigger common workflows.
Get Meshtastic
The easiest and fastest way to get the latest releases is to use our GitHub releases. It is recommended to use these with Obtainium to get the latest updates automatically.
Alternatively, these other providers are also available, but may be slower to update.
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
width="24%">](https://f-droid.org/packages/com.geeksville.mesh/)
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png"
alt="Get it on IzzyOnDroid"
width="24%">](https://apt.izzysoft.de/fdroid/index/apk/com.geeksville.mesh)
[<img src="https://github.com/machiav3lli/oandbackupx/blob/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png"
alt="Get it on GitHub"
width="24%">](https://github.com/meshtastic/Meshtastic-Android/releases)
[<img src="https://play.google.com/intl/enus/badges/static/images/badges/enbadgewebgeneric.png"
alt="Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh]"
width="24%">](https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source%3Dgithub-android-readme)
The play store is the last to update of these options, but if you want to join the Play Store testing program go to this URL and opt-in to become a tester.
If you encounter any problems or have questions, ask us on the discord, create an issue, or post in the forum and we'll help as we can.
Desktop
Meshtastic Desktop installers (macOS DMG, Windows MSI/EXE, Linux DEB/RPM/AppImage) are available from GitHub Releases. A Flatpak package is maintained at vidplace7/org.meshtastic.desktop.
Documentation
Both sites are deployed to GitHub Pages automatically on every push to T383838main.
βββββββββββββββββββββββββ¬βββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Site β URL β Contents β
βββββββββββββββββββββββββΌβββββββββββΌββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
Module Documentation
Each module has its own README with details on its responsibilities, API surface, and internal design.
ββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Module β Description β
ββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
β core/do.
Integration
The app includes a built-in Local TAK Server feature that can be enabled in settings. This runs a local TCP server on port 8089 to allow ATAK clients to connect directly and route their traffic over the mesh.
Building the Android App
β [!WARNING] Debug and release builds can be installed concurrently. This is solely to enable
β smoother development, and you should avoid running both apps simultaneously. To ensure proper
β function, force quit the app not in use.
https://meshtastic.org/docs/development/android/
Note: when building the T383838google flavor locally you will need to supply your own Google Maps Android SDK api key T383838MAPS_API_KEY in T383838local.properties in order to use Google Maps.
e.g.
T282828
Te6edf3MAPS_API_KEYTff7b72=Ta5d6ffyour_google_maps_api_key_here
Contributing guidelines
For detailed instructions on how to contribute, please see our CONTRIBUTING.md file.
For details on our release process, see the RELEASE_PROCESS.md file.
Repository Statistics
Served by rngit 1.4.2 - Generated in 0.17s